Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[IMP] VoIP: Combine VoIP Actions Docs #12596

Open
wants to merge 1 commit into
base: 18.0
Choose a base branch
from

Conversation

justinmallette
Copy link
Contributor

@justinmallette justinmallette commented Mar 21, 2025

Combine VoIP Widget and VoIP actions ("Make, receive, transfer, forward calls") articles. Create redirect rule. Delete instruction pathing that was transferred to VoIP home page (#12538)

https://www.odoo.com/odoo/project/3835/tasks/4665325

@robodoo
Copy link
Collaborator

robodoo commented Mar 21, 2025

Pull request status dashboard

@C3POdoo C3POdoo requested a review from a team March 21, 2025 19:49
@justinmallette justinmallette force-pushed the 18.0-voip-widget-rmv-instructions-juma branch from 58a00c5 to a0a319d Compare March 21, 2025 20:20
@justinmallette
Copy link
Contributor Author

@jero-odoo ready for peer review

To transfer a call within the |VOIP| widget, first, answer the call using the green :icon:`fa-phone`
:guilabel:`(phone)` icon.

Once the incoming call is answered, click the :icon:`fa-arrows-h` :guilabel:`(left-right arrows)`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jero-odoo for when you're reviewing: Vale wants this to be Expand All but that doesn't fit in the context of what this button is. I talked in person with @Felicious and we decided this route, but please weigh in if you think of something better!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@justinmallette justinmallette force-pushed the 18.0-voip-widget-rmv-instructions-juma branch 2 times, most recently from 4edfc63 to 4e17c8a Compare March 21, 2025 22:01
Copy link
Contributor

@jero-odoo jero-odoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @justinmallette sorry for the delay on this, let me know if you have any questions. Thanks!

@@ -109,8 +28,8 @@ This includes incoming and outgoing calls. Any number can be clicked to begin a
Next activities tab
-------------------

Under the :guilabel:`Next Activities` tab of the |VOIP| widget, a user can see any activities
assigned to them, and which ones are due to be completed for the day.
Under the :guilabel:`Next Activities` tab of the |VOIP| widget, a user can see any calls assigned to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it just calls though? Because looking at runbot it looks like you can also see activities as well.

Comment on lines 89 to 87
- Click the :icon:`oi-voip` :guilabel:`(VoIP)` icon, located in the top-right of the navigation bar.
Then, click the :icon:`fa-phone` :guilabel:`(phone)` icon to redial the last called contact.
- Click the :icon:`oi-voip` :guilabel:`(VoIP)` icon, located in the top-right of the navigation bar.
Then, search for a specific contact's name or go to the :guilabel:`Contacts` tab. Then, select the
contact and click the :icon:`fa-phone` :guilabel:`(phone)` icon.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is pretty long-winded and repetitive, can it be shortened? Something like "From the navigation bar, there are three ways to make a call: entering the phone number, clicking the phone icon, searching through contacts"


To send an email through the |VOIP| widget, click the :icon:`oi-voip` :guilabel:`(VoIP)` icon,
located in the top navigation bar. When this is clicked, the |VOIP| widget will appear in the
bottom-right corner of the page. Then, search for a contact to email or find them in the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It appears in the bottom left for me on Runbot

@@ -154,13 +158,13 @@ Each section below goes through common issues with the |VOIP| widget and how to
Missing parameter
-----------------

If a *Missing Parameter* error message appears in the Odoo |VOIP| widget, refresh the Odoo window,
and try again.
If a *Missing Parameter* error message appears in the |VOIP| widget, refresh the window, and try
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If possible, this would be a great place for an image

@justinmallette justinmallette force-pushed the 18.0-voip-widget-rmv-instructions-juma branch from 89d4941 to 1fe9f65 Compare March 27, 2025 16:29
Co-authored-by: Jess Rogers <[email protected]>
@justinmallette justinmallette force-pushed the 18.0-voip-widget-rmv-instructions-juma branch from f13a4e2 to 5fe23d0 Compare March 27, 2025 17:24
@justinmallette
Copy link
Contributor Author

@Felicious ready for final review

Copy link
Contributor

@Felicious Felicious left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, @justinmallette !

This is a really nice restructure—removing the redundant configuration steps and merging the related calling and forwarding info into the same doc makes a lot of sense. I also tested the redirect rule, and it works perfectly!

I did notice one small spot in the doc where we could add a bit more clarification and align with our team’s style, but it’s a minor tweak. Once you’ve had a chance to take a look at that, I’ll do a quick final review and get this approved—it’s almost ready to go!

Great work so far! 😊🚀

Comment on lines +29 to +30
applications/productivity/voip/transfer_forward.rst applications/productivity/voip/voip_widget.rst
# Combine content, delete transfer_forward.rst
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the one time we don't care about a max line of 100 characters (:

We also have a convention of commenting the redirects. I've made an attempt, but @samueljlieber will probably go over this in his technical review (:

Suggested change
applications/productivity/voip/transfer_forward.rst applications/productivity/voip/voip_widget.rst
# Combine content, delete transfer_forward.rst
applications/productivity/voip/transfer_forward.rst applications/productivity/voip/voip_widget.rst # voip/transfer_forward --> voip/voip_widget

@@ -131,6 +50,16 @@ When viewing the activity, the user can also manage the activity's details and s
To call the customer related to a scheduled activity, click the :icon:`fa-phone` :guilabel:`(phone)`
icon. Click the :icon:`fa-keyboard-o` :guilabel:`(keyboard)` icon to dial another number.

Add a call to the Next Activities tab
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Total nitpick, but since we prioritize documenting actions, I don't think it's necessary to specify that we're doing this in the Next Activities tab.

Suggested change
Add a call to the Next Activities tab
Add a call

Comment on lines +56 to +57
To add a call to the :guilabel:`Next activities` tab, click the green :icon:`fa-phone`
:guilabel:`(phone)` icon, while in Kanban view of the **CRM** application.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not too sure about what this icon is. Is it this?

image

Asking because I didn't see this opportunity get added to the Next Activities tab

image

Add a call to the Next Activities tab
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To add a call to the :guilabel:`Next activities` tab, click the green :icon:`fa-phone`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we have to be in the CRM app to add the person to the tab, let's instruct the reader to go there first, before clicking the green phone icon (:

In fact, let's be overly specific for the users who are unfamiliar with VoIP. Let's tell them to go to the CRM app, and open the VOIP widget. Then, tell them to hover over the intended opportunity, and click the phone icon that appears.

.. tip::
To find the extension for a user, consult the |VOIP| administrator. If the user has
:guilabel:`Administration` access rights set to :guilabel:`Settings`, find extensions by going to
:menuselection:`Settings App --> Manage Users --> Select the user --> Preferences --> VOIP -->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We typically use menuselection only when navigating through headings and dropdown menus. Since "Manage Users" is a button rather than part of a menu path, let’s adjust the phrasing to reflect that.

While testing, I noticed there the Preferences tab wasn't used. Instead, we went to the "VoIP" (with a lowercase "o") tab. Being detail-oriented about button names, tab labels, and other UI elements (yes, even with the capitalization!) is crucial to avoid confusion for users.

Here’s a suggestion for how we could rephrase this:

Suggested change
:menuselection:`Settings App --> Manage Users --> Select the user --> Preferences --> VOIP -->
:menuselection:`Settings app` and click the :icon:`[icon for the arrow]` :guilabel:`Manage Users` button. Select the user, and go to the :guilabel:`VoIP` tab. Then, in the :guilabel:`VoIP username` field...

Also:
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants